Skip to content

[Security] Add ability for voters to explain their vote #20690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025

Conversation

MrYamous
Copy link
Contributor

Fix #20658

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matthieu, this is a good start, but I think we should also display an example of using this feature to add an explanation in some of the voter examples.

If you return ``true`` from ``supports()``, then this method is called. Your
job is to return ``true`` to allow access and ``false`` to deny access.
The ``$token`` can be used to find the current user object (if any). In this
example, all of the complex business logic is included to determine access.
The ``$token`` can be used to find the current user object (if any). The ``$vote``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps document were this can be seen? or retrieved to be displayed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure to understand your point here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant something like the workflow transition blocker message
is it possible to see this "vote message" somewhere and how ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @94noni. Having a short section explaining how to retrieve and display the reasons to users would be a great addition. It would help developers make better use of the new Vote object in real-world applications.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some tweaks while merging, but we can do further tweaks in future PRs if we think this needs to be improved. Thanks.


if (!$user instanceof User) {
// the user must be logged in; if not, deny access
$vote->reasons[] = 'The user is not logged in.';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should instead use the addReason() method.

$vote?->addReason('The user is not logged in.');

{
$user = $token->getUser();
$vote ??= new Vote();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be removed while accounting for @javiereguiluz's comment:

Suggested change
$vote ??= new Vote();

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed while merging. Thanks.

return true;
}

$vote->reasons[] = 'You are not the owner of the Post.';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$vote is undefined in this example, I guess a few more changes are needed to pass $vote

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed while merging. Thanks.

Copy link
Member

@nicolas-grekas nicolas-grekas May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really, the private method has no $vote argument ;)

@javiereguiluz javiereguiluz merged commit 523229b into symfony:7.3 May 23, 2025
3 checks passed
@javiereguiluz
Copy link
Member

Thanks Matthieu!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Security] Add ability for voters to explain their vote
7 participants